home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
BBS Toolkit
/
BBS Toolkit.iso
/
opus
/
wink_101.zip
/
WINK.DOC
< prev
next >
Wrap
Text File
|
1992-11-12
|
12KB
|
371 lines
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
QWK as a WINK ;-)
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
-------------
INTRODUCTION:
-------------
WINK is a door for the Opus CBCS. WINK provides your users access to
messages using the QWK mail format. It is very tightly intergrated
with Opus, making it easy to set up for you and easy to operate for
your users.
What does WINK cost? The same as my other Opus programs OBUL, OASWAP,
and ARKALOG. Nothing. WINK is free software in the Opus tradition.
Enjoy it and please report any "features-of-ill-repute" to the author.
There is a registration option mentioned later in this document.
---------
FEATURES:
---------
The following is a list of the major features found in WINK. If you
would like to see something added to this list, contact the author.
- works with Opus 1.1x and up
- supports multiline/multitask usage
- works with any com port via FOSSIL
- runs remote and local
- runs stand alone if last login was local
- sysop defined file archivers
- sysop defined transfer protocols
- handles messages of any size
- no door/drop file needed, pulls info from Opus files
- checks privileges & locks for area access
- checks privileges & locks for edit access
- prevents forged messages
- prevents adding messages to readonly areas
- private message posted in public area is made public
- filenames can be task number tagged
- generates echotoss.log file
- update all last read pointers
- does not download authored messages
- commands can be stacked
- new pine scent with no greasy residue
---------
MANIFEST:
---------
WINK.HIS - release history & quick upgrade instructions
WINK11.EXE - the Opus 1.1x executable
WINK17.EXE - the Opus 1.7x/1.8x/1.9x executable
WINK.CFG - quick start configuration file
WINK_CFG.DOC - docs for configuration file
WINK.DOC - this documentation
You may have a package that contains only one executable.
------------
QUICK START:
------------
If you are upgrading from the last release, you should read
WINK.HIS for quick upgrade instructions.
If you are installing WINK for the first time, or you are
skipping some releases, then follow these instructions.
- copy all files to your Opus directory
- rename the appropriate EXE version to WINK.EXE
- edit WINK.CFG and follow directions listed there
- add an Opus menu option, for example:
_OUTSIDE Normal "WINK" = DOS c:\opus\wink.exe
- time to rock-n-roll (Rush preferred)
NOTE: The quick start CFG file requires that PKZIP,
PKUNZIP, and DSZ be located in your PATH.
------------
REGISTERING:
------------
If you decided to send a monetary donation to the author you will:
- receive a special version of the WINK Door which
adds a plaque proclaiming your registered support
- receive express attention in submitted bug fixes
and any enhancements that you request
- receive beta releases of new versions and planned
new support utilities
- see to it that WINK development continues for the
enjoyment of future generations of Cool Shades
- receive a registration program to auto register
future releases
- get that warm fuzzy feeling
To register WINK, send not more than US$25. Be sure to select a
shipping option from the list below and include a copy of the
SYSOP variable from the SYSTEM SECTION of your Opus BBS.CTL file.
This name will be used as the registration key. It will also be
placed in the QWK control file that is sent to your users and
will also be placed on your registration plaque. If this name
is incorrect, please include an explanation.
SYSTEM SECTION
%
SYSOP Keith Ford
%
When selecting a shipping option, be sure to include ALL the needed
information such as passwords, phone numbers, addresses, etc.
The shipping options are many. Please pick one.
- uuencode and email (preferred)
[ need your email address]
- file attach to your Fidonet node
[ need your net address]
- login to your bbs and upload
[ need login/password/filearea with upload privileges ]
- snail mail
[ need your address ]
- personal delivery
[ need your car ]
----------------------
CONTACTING THE AUTHOR:
----------------------
BBS NAME: Micro Magic __
PHONE: +1 205 830 2362 / \ Can you identify
MODEM: USR DS - HST/V32bis \__/ this object?
FREQ: WINK [__]
FIDONET: 1:373/12
INTERNET: sysop@umagic.fidonet.org
SNAIL: 203 Creek Trail, Madison, AL, 35758
ICBM: 34 44 18 N / 86 35 19 W
WINK will always be available on Micro Magic. The latest version
can be file requested with the magic name WINK, which will contain
all the executables. You can also request WINK for specific versions
of Opus with magic names WINK11 & WINK17.
----------------
VERSION NUMBERS:
----------------
The version number of WINK will always be a 3 digit hexadecimal number.
The version number will be X.Y.Z and the archived filename will be
WINK_XYZ.??? where X, Y, & Z are defined as follows.
X - major change, if you use this EXE you MUST change your
CFG file according to the release notes
Y - new features, you can use this EXE without changing your
CFG file, but to use the new features you must change
your CFG file according to the release notes
Z - bug fix, simply replace the executable and read the
relese notes
----------------
PROGRAM DETAILS:
----------------
MULTILINE SUPPORT
WINK read the Opus PRM file for much of its information. If you have a
multiline system, you will have multiple PRM files. For WINK to work,
it must be told where the PRM file is located. You can do this with
the OPUS environment variable or with the -PRM command line parameter.
For more information on where WINK looks for files, read the section
named "WHERE WINK LOOKS FOR FILES" in this text.
Any filename specified with WINK that contains a # or ## will
be modified such that the # or ## is replaced with the hexadecimal
task number. If these files are not found, the name is modified
again to exclude the task numbers. If task number is decimal 10,
then WINK##.CFG would be WINK0A.cfg, then WINK.CFG.
RUNNING LOCAL OR STANDALONE
When in one of these modes, WINK places <bbsid>.QWK in the temporary
directory and looks for <bbsid>.REP there too. The temporary directory
is found in the PRM file or from the WINK -tmp command line argument.
WINK reads the LASTUSER record, so running STANDALONE will run as if
that person were logged on. Use OPUS -K if you need to change the
LASTUSER record to be yours.
AREA NAMING
The name of a message area is limited to 10 characters. In Opus 1.1x,
the first 10 characters of the message area name are used. In Opus
1.7x, the first area name definition in the CTL file is used. Opus allows
you to define this area name two different ways.
(#1) AREA 0001 Meadow
(#2) AREA 0002
NAME Meadow
WHERE WINK LOOKS FOR FILES
look for OPUS environment variable pointing to BBS.PRM
check command line parameters:
-log : path to log file
-prm : path to bbs.prm file
-sys : directory containing area definitions
-lastus : path to LASTUS file
-opus : directory of opusroot (echotoss & lastus for 1.1x)
-tmp : directory for temporary work files
-cfg : path to wink.cfg file
-usr : path to wink.usr file
if OPUS and !-opus, form opusroot from OPUS by stripping BBS.PRM
else if !OPUS and -opus, form PRM from opusroot plus BBS.PRM
if !PRM, look in current directory
if !LASTUS, 1.1x uses opusroot & 1.7x looks in PRM
if !TMP, look in PRM, append WINKxx.TMP
if !SYS, look in PRM
1.1x looks for SYSTEMxx.DAT files
1.7x looks for sysmsg.dat
if !CFG, look in current directory
if !USR, look in current directory
echotoss.log uses
1.1x - in opusroot
1.7x - pulled from PRM
WHICH FILES ARE MODIFIED
wink##.usr
last read files
lastus##.dat
MENU DESCRIPTION
C........user configuration for packer & protocol
#........toggle area # on and off
#f.......toggle flag for area # on and off
(only P flag supported for Personal messages)
L........list available message areas
L#.......list available message areas starting with #
LS.......list selected message areas
LS#......list selected message areas starting with #
D........download QWK packet
DP.......override area flags, download only personal messages
DA.......override area flags, download all messages
U........upload REP packet
Q........quit back to the bbs
G........goodbye and logoff now
=........credits
*........registration plaque
?........help
----------------
WINK.CFG FORMAT:
----------------
See WINK_CFG.DOC file for this information.
----------------
WINK.USR FORMAT:
----------------
You should not need to worry about this file. If something goes
wrong, you can edit it by hand to an extent. Following is the
format for a record in this file. This record is repeated for
each active WINK user.
User Name
userflags
crc-of-packer-menu-text
crc-of-protocol-menu-text
area# flags
area# flags
area# flags
-----------
THE AUTHOR:
-----------
Other software available from the author.
OBUL - Generate a .BBS file that presents a menu to a caller.
This menu is based upon a list of bulletins provided
by the sysop. Any bulletins which have been modified
since the user last visited, are marked on the menu.
This works for Opus 1.1x and up.
ARKALOG - Archive a log file with date embedded in the filename.
Such as OLOG9210.LZH would be my Opus log for the 10th
month of 1992. This program also has a day of the week
check to automate weekly functions. It will work with
any Opus, or any bbs.
OASWAP - In Opus 1.1x message & file areas are tied together.
OASWAP will allow you to swap between areas the message
or file information independently of one another. This
works with Opus 1.1x only.
-------------
FUTURE PLANS:
-------------
- sysop defined menu coloring
- sysop defined area names
- sysop exclusion of certain message areas
- multiple language using '~'
- change last read pointer on exit only
- menu option to set/reset last read pointers
- sysop defined NEWFILES generation command
- use PEEK privs/locks for private in public echos
- handle area number greater than 255
- send messages that match a search string
---------------
KNOWN PROBLEMS:
---------------
Last Read Pointers not updated for sysop.
The WINK tear line may be missing from some messages.
The QWK format does not have a way to include Fidonet addresses.
Therefore, there is no support for net mail messages.
------------------------------
FOR THE TECHNO HUMOR IMPAIRED:
------------------------------
An emoticon is a small figure (icon) comprised of ASCII characters
used to denote and emotion. Many emoticons depict a face and require
you to tilt your head (or monitor) to the left (or right). The ";-)"
is an emoticon representing a winking face, to denote humor,
understanding, sarcasm, and such. So there you have